<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Table xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/torque/engine/database/model/Table.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../../../org/apache/torque/engine/database/model/package-summary.html">org.apache.torque.engine.database.model</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.ArrayList;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Collections;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Hashtable;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Iterator;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.List;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.Map;
<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.commons.collections.map.ListOrderedMap;
<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.commons.lang.StringUtils;
<a name="30" href="#30">30</a>  
<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.torque.engine.EngineException;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  <strong>import</strong> org.xml.sax.Attributes;
<a name="37" href="#37">37</a>  
<a name="38" href="#38">38</a>  <em>/**<em>*</em></em>
<a name="39" href="#39">39</a>  <em> * Data about a table used in an application.</em>
<a name="40" href="#40">40</a>  <em> *</em>
<a name="41" href="#41">41</a>  <em> * @author &lt;a href="<a href="mailto:leon@opticode.co.za" target="alexandria_uri">mailto:leon@opticode.co.za</a>">Leon Messerschmidt&lt;/a></em>
<a name="42" href="#42">42</a>  <em> * @author &lt;a href="<a href="mailto:jvanzyl@apache.org" target="alexandria_uri">mailto:jvanzyl@apache.org</a>">Jason van Zyl&lt;/a></em>
<a name="43" href="#43">43</a>  <em> * @author &lt;a href="<a href="mailto:mpoeschl@marmot.at" target="alexandria_uri">mailto:mpoeschl@marmot.at</a>>Martin Poeschl&lt;/a></em>
<a name="44" href="#44">44</a>  <em> * @author &lt;a href="<a href="mailto:jmcnally@collab.net" target="alexandria_uri">mailto:jmcnally@collab.net</a>>John McNally&lt;/a></em>
<a name="45" href="#45">45</a>  <em> * @author &lt;a href="<a href="mailto:dlr@collab.net" target="alexandria_uri">mailto:dlr@collab.net</a>>Daniel Rall&lt;/a></em>
<a name="46" href="#46">46</a>  <em> * @author &lt;a href="<a href="mailto:byron_foster@byron_foster@yahoo.com" target="alexandria_uri">mailto:byron_foster@byron_foster@yahoo.com</a>>Byron Foster&lt;/a></em>
<a name="47" href="#47">47</a>  <em> * @author &lt;a href="<a href="mailto:monroe@dukece.com" target="alexandria_uri">mailto:monroe@dukece.com</a>>Greg Monroe&lt;/a></em>
<a name="48" href="#48">48</a>  <em> * @version $Id: Table.java 473814 2006-11-11 22:30:30Z tv $</em>
<a name="49" href="#49">49</a>  <em> */</em>
<a name="50" href="#50">50</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> implements <a href="../../../../../../org/apache/torque/engine/database/model/IDMethod.html">IDMethod</a>
<a name="51" href="#51">51</a>  {
<a name="52" href="#52">52</a>      <em>/**<em>* Logging class from commons.logging */</em></em>
<a name="53" href="#53">53</a>      <strong>private</strong> <strong>static</strong> Log log = LogFactory.getLog(Table.<strong>class</strong>);
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <em class="comment">//private AttributeListImpl attributes;</em>
<a name="56" href="#56">56</a>      <strong>private</strong> List columnList;
<a name="57" href="#57">57</a>      <strong>private</strong> List foreignKeys;
<a name="58" href="#58">58</a>      <strong>private</strong> List indices;
<a name="59" href="#59">59</a>      <strong>private</strong> List unices;
<a name="60" href="#60">60</a>      <strong>private</strong> List idMethodParameters;
<a name="61" href="#61">61</a>      <strong>private</strong> String name;
<a name="62" href="#62">62</a>      <strong>private</strong> String description;
<a name="63" href="#63">63</a>      <strong>private</strong> String javaName;
<a name="64" href="#64">64</a>      <strong>private</strong> String idMethod;
<a name="65" href="#65">65</a>      <strong>private</strong> String javaNamingMethod;
<a name="66" href="#66">66</a>      <strong>private</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Database.html">Database</a> tableParent;
<a name="67" href="#67">67</a>      <strong>private</strong> List referrers;
<a name="68" href="#68">68</a>      <strong>private</strong> List foreignTableNames;
<a name="69" href="#69">69</a>      <strong>private</strong> <strong>boolean</strong> containsForeignPK;
<a name="70" href="#70">70</a>      <strong>private</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> inheritanceColumn;
<a name="71" href="#71">71</a>      <strong>private</strong> <strong>boolean</strong> skipSql;
<a name="72" href="#72">72</a>      <strong>private</strong> <strong>boolean</strong> abstractValue;
<a name="73" href="#73">73</a>      <strong>private</strong> String alias;
<a name="74" href="#74">74</a>      <strong>private</strong> String enterface;
<a name="75" href="#75">75</a>      <strong>private</strong> String pkg;
<a name="76" href="#76">76</a>      <strong>private</strong> String baseClass;
<a name="77" href="#77">77</a>      <strong>private</strong> String basePeer;
<a name="78" href="#78">78</a>      <strong>private</strong> Hashtable columnsByName;
<a name="79" href="#79">79</a>      <strong>private</strong> Hashtable columnsByJavaName;
<a name="80" href="#80">80</a>      <strong>private</strong> <strong>boolean</strong> needsTransactionInPostgres;
<a name="81" href="#81">81</a>      <strong>private</strong> <strong>boolean</strong> heavyIndexing;
<a name="82" href="#82">82</a>      <strong>private</strong> <strong>boolean</strong> forReferenceOnly;
<a name="83" href="#83">83</a>      <strong>private</strong> Map options;
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <em>/**<em>*</em></em>
<a name="86" href="#86">86</a>  <em>     * Default Constructor</em>
<a name="87" href="#87">87</a>  <em>     */</em>
<a name="88" href="#88">88</a>      <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a>()
<a name="89" href="#89">89</a>      {
<a name="90" href="#90">90</a>          <strong>this</strong>(<strong>null</strong>);
<a name="91" href="#91">91</a>      }
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>      <em>/**<em>*</em></em>
<a name="94" href="#94">94</a>  <em>     * Constructs a table object with a name</em>
<a name="95" href="#95">95</a>  <em>     *</em>
<a name="96" href="#96">96</a>  <em>     * @param name table name</em>
<a name="97" href="#97">97</a>  <em>     */</em>
<a name="98" href="#98">98</a>      <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a>(String name)
<a name="99" href="#99">99</a>      {
<a name="100" href="#100">100</a>         <strong>this</strong>.name = name;
<a name="101" href="#101">101</a>         columnList = <strong>new</strong> ArrayList();
<a name="102" href="#102">102</a>         foreignKeys = <strong>new</strong> ArrayList(5);
<a name="103" href="#103">103</a>         indices = <strong>new</strong> ArrayList(5);
<a name="104" href="#104">104</a>         unices = <strong>new</strong> ArrayList(5);
<a name="105" href="#105">105</a>         columnsByName = <strong>new</strong> Hashtable();
<a name="106" href="#106">106</a>         columnsByJavaName = <strong>new</strong> Hashtable();
<a name="107" href="#107">107</a>         options = Collections.synchronizedMap(<strong>new</strong> ListOrderedMap());
<a name="108" href="#108">108</a>     }
<a name="109" href="#109">109</a> 
<a name="110" href="#110">110</a>     <em>/**<em>*</em></em>
<a name="111" href="#111">111</a> <em>     * Load the table object from an xml tag.</em>
<a name="112" href="#112">112</a> <em>     *</em>
<a name="113" href="#113">113</a> <em>     * @param attrib xml attributes</em>
<a name="114" href="#114">114</a> <em>     * @param defaultIdMethod defined at db level</em>
<a name="115" href="#115">115</a> <em>     */</em>
<a name="116" href="#116">116</a>     <strong>public</strong> <strong>void</strong> loadFromXML(Attributes attrib, String defaultIdMethod)
<a name="117" href="#117">117</a>     {
<a name="118" href="#118">118</a>         name = attrib.getValue(<span class="string">"name"</span>);
<a name="119" href="#119">119</a>         javaName = attrib.getValue(<span class="string">"javaName"</span>);
<a name="120" href="#120">120</a>         idMethod = attrib.getValue(<span class="string">"idMethod"</span>);
<a name="121" href="#121">121</a> 
<a name="122" href="#122">122</a>         <em class="comment">// retrieves the method for converting from specified name to</em>
<a name="123" href="#123">123</a>         <em class="comment">// a java name.</em>
<a name="124" href="#124">124</a>         javaNamingMethod = attrib.getValue(<span class="string">"javaNamingMethod"</span>);
<a name="125" href="#125">125</a>         <strong>if</strong> (javaNamingMethod == <strong>null</strong>)
<a name="126" href="#126">126</a>         {
<a name="127" href="#127">127</a>             javaNamingMethod = getDatabase().getDefaultJavaNamingMethod();
<a name="128" href="#128">128</a>         }
<a name="129" href="#129">129</a> 
<a name="130" href="#130">130</a>         <strong>if</strong> (<span class="string">"null"</span>.equals(idMethod))
<a name="131" href="#131">131</a>         {
<a name="132" href="#132">132</a>             idMethod = defaultIdMethod;
<a name="133" href="#133">133</a>         }
<a name="134" href="#134">134</a>         skipSql = <span class="string">"true"</span>.equals(attrib.getValue(<span class="string">"skipSql"</span>));
<a name="135" href="#135">135</a>         <em class="comment">// pkg = attrib.getValue("package");</em>
<a name="136" href="#136">136</a>         abstractValue = <span class="string">"true"</span>.equals(attrib.getValue(<span class="string">"abstract"</span>));
<a name="137" href="#137">137</a>         baseClass = attrib.getValue(<span class="string">"baseClass"</span>);
<a name="138" href="#138">138</a>         basePeer = attrib.getValue(<span class="string">"basePeer"</span>);
<a name="139" href="#139">139</a>         alias = attrib.getValue(<span class="string">"alias"</span>);
<a name="140" href="#140">140</a>         heavyIndexing = <span class="string">"true"</span>.equals(attrib.getValue(<span class="string">"heavyIndexing"</span>))
<a name="141" href="#141">141</a>                 || (!<span class="string">"false"</span>.equals(attrib.getValue(<span class="string">"heavyIndexing"</span>))
<a name="142" href="#142">142</a>                 &amp;&amp; getDatabase().isHeavyIndexing());
<a name="143" href="#143">143</a>         description = attrib.getValue(<span class="string">"description"</span>);
<a name="144" href="#144">144</a>         enterface = attrib.getValue(<span class="string">"interface"</span>);
<a name="145" href="#145">145</a>     }
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a>     <em>/**<em>*</em></em>
<a name="148" href="#148">148</a> <em>     * &lt;p>A hook for the SAX XML parser to call when this table has</em>
<a name="149" href="#149">149</a> <em>     * been fully loaded from the XML, and all nested elements have</em>
<a name="150" href="#150">150</a> <em>     * been processed.&lt;/p></em>
<a name="151" href="#151">151</a> <em>     *</em>
<a name="152" href="#152">152</a> <em>     * &lt;p>Performs heavy indexing and naming of elements which weren't</em>
<a name="153" href="#153">153</a> <em>     * provided with a name.&lt;/p></em>
<a name="154" href="#154">154</a> <em>     */</em>
<a name="155" href="#155">155</a>     <strong>public</strong> <strong>void</strong> doFinalInitialization()
<a name="156" href="#156">156</a>     {
<a name="157" href="#157">157</a>         <em class="comment">// Heavy indexing must wait until after all columns composing</em>
<a name="158" href="#158">158</a>         <em class="comment">// a table's primary key have been parsed.</em>
<a name="159" href="#159">159</a>         <strong>if</strong> (heavyIndexing)
<a name="160" href="#160">160</a>         {
<a name="161" href="#161">161</a>             doHeavyIndexing();
<a name="162" href="#162">162</a>         }
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a>         <em class="comment">// Name any indices which are missing a name using the</em>
<a name="165" href="#165">165</a>         <em class="comment">// appropriate algorithm.</em>
<a name="166" href="#166">166</a>         doNaming();
<a name="167" href="#167">167</a>     }
<a name="168" href="#168">168</a> 
<a name="169" href="#169">169</a>     <em>/**<em>*</em></em>
<a name="170" href="#170">170</a> <em>     * &lt;p>Adds extra indices for multi-part primary key columns.&lt;/p></em>
<a name="171" href="#171">171</a> <em>     *</em>
<a name="172" href="#172">172</a> <em>     * &lt;p>For databases like MySQL, values in a where clause must</em>
<a name="173" href="#173">173</a> <em>     * match key part order from the left to right.  So, in the key</em>
<a name="174" href="#174">174</a> <em>     * definition &lt;code>PRIMARY KEY (FOO_ID, BAR_ID)&lt;/code>,</em>
<a name="175" href="#175">175</a> <em>     * &lt;code>FOO_ID&lt;/code> &lt;i>must&lt;/i> be the first element used in</em>
<a name="176" href="#176">176</a> <em>     * the &lt;code>where&lt;/code> clause of the SQL query used against</em>
<a name="177" href="#177">177</a> <em>     * this table for the primary key index to be used.  This feature</em>
<a name="178" href="#178">178</a> <em>     * could cause problems under MySQL with heavily indexed tables,</em>
<a name="179" href="#179">179</a> <em>     * as MySQL currently only supports 16 indices per table (i.e. it</em>
<a name="180" href="#180">180</a> <em>     * might cause too many indices to be created).&lt;/p></em>
<a name="181" href="#181">181</a> <em>     *</em>
<a name="182" href="#182">182</a> <em>     * &lt;p>See &lt;a href="<a href="http://www.mysql.com/doc/E/X/EXPLAIN.html" target="alexandria_uri">http://www.mysql.com/doc/E/X/EXPLAIN.html</a>">the</em>
<a name="183" href="#183">183</a> <em>     * manual&lt;/a> for a better description of why heavy indexing is</em>
<a name="184" href="#184">184</a> <em>     * useful for quickly searchable database tables.&lt;/p></em>
<a name="185" href="#185">185</a> <em>     */</em>
<a name="186" href="#186">186</a>     <strong>private</strong> <strong>void</strong> doHeavyIndexing()
<a name="187" href="#187">187</a>     {
<a name="188" href="#188">188</a>         <strong>if</strong> (log.isDebugEnabled())
<a name="189" href="#189">189</a>         {
<a name="190" href="#190">190</a>             log.debug(<span class="string">"doHeavyIndex() called on table "</span> + name);
<a name="191" href="#191">191</a>         }
<a name="192" href="#192">192</a> 
<a name="193" href="#193">193</a>         List pk = getPrimaryKey();
<a name="194" href="#194">194</a>         <strong>int</strong> size = pk.size();
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>         <strong>try</strong>
<a name="197" href="#197">197</a>         {
<a name="198" href="#198">198</a>             <em class="comment">// We start at an offset of 1 because the entire column</em>
<a name="199" href="#199">199</a>             <em class="comment">// list is generally implicitly indexed by the fact that</em>
<a name="200" href="#200">200</a>             <em class="comment">// it's a primary key.</em>
<a name="201" href="#201">201</a>             <strong>for</strong> (<strong>int</strong> i = 1; i &lt; size; i++)
<a name="202" href="#202">202</a>             {
<a name="203" href="#203">203</a>                 addIndex(<strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Index.html">Index</a>(<strong>this</strong>, pk.subList(i, size)));
<a name="204" href="#204">204</a>             }
<a name="205" href="#205">205</a>         }
<a name="206" href="#206">206</a>         <strong>catch</strong> (EngineException e)
<a name="207" href="#207">207</a>         {
<a name="208" href="#208">208</a>             log.error(e, e);
<a name="209" href="#209">209</a>         }
<a name="210" href="#210">210</a>     }
<a name="211" href="#211">211</a> 
<a name="212" href="#212">212</a>     <em>/**<em>*</em></em>
<a name="213" href="#213">213</a> <em>     * Names composing objects which haven't yet been named.  This</em>
<a name="214" href="#214">214</a> <em>     * currently consists of foreign-key and index entities.</em>
<a name="215" href="#215">215</a> <em>     */</em>
<a name="216" href="#216">216</a>     <strong>private</strong> <strong>void</strong> doNaming()
<a name="217" href="#217">217</a>     {
<a name="218" href="#218">218</a>         <strong>int</strong> i;
<a name="219" href="#219">219</a>         <strong>int</strong> size;
<a name="220" href="#220">220</a>         String name;
<a name="221" href="#221">221</a> 
<a name="222" href="#222">222</a>         <em class="comment">// Assure names are unique across all databases.</em>
<a name="223" href="#223">223</a>         <strong>try</strong>
<a name="224" href="#224">224</a>         {
<a name="225" href="#225">225</a>             <strong>for</strong> (i = 0, size = <strong>for</strong>eignKeys.size(); i &lt; size; i++)
<a name="226" href="#226">226</a>             {
<a name="227" href="#227">227</a>                 <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> fk = (ForeignKey) foreignKeys.get(i);
<a name="228" href="#228">228</a>                 name = fk.getName();
<a name="229" href="#229">229</a>                 <strong>if</strong> (StringUtils.isEmpty(name))
<a name="230" href="#230">230</a>                 {
<a name="231" href="#231">231</a>                     name = acquireConstraintName(<span class="string">"FK"</span>, i + 1);
<a name="232" href="#232">232</a>                     fk.setName(name);
<a name="233" href="#233">233</a>                 }
<a name="234" href="#234">234</a>             }
<a name="235" href="#235">235</a> 
<a name="236" href="#236">236</a>             <strong>for</strong> (i = 0, size = indices.size(); i &lt; size; i++)
<a name="237" href="#237">237</a>             {
<a name="238" href="#238">238</a>                 <a href="../../../../../../org/apache/torque/engine/database/model/Index.html">Index</a> index = (Index) indices.get(i);
<a name="239" href="#239">239</a>                 name = index.getName();
<a name="240" href="#240">240</a>                 <strong>if</strong> (StringUtils.isEmpty(name))
<a name="241" href="#241">241</a>                 {
<a name="242" href="#242">242</a>                     name = acquireConstraintName(<span class="string">"I"</span>, i + 1);
<a name="243" href="#243">243</a>                     index.setName(name);
<a name="244" href="#244">244</a>                 }
<a name="245" href="#245">245</a>             }
<a name="246" href="#246">246</a> 
<a name="247" href="#247">247</a>             <strong>for</strong> (i = 0, size = unices.size(); i &lt; size; i++)
<a name="248" href="#248">248</a>             {
<a name="249" href="#249">249</a>                 <a href="../../../../../../org/apache/torque/engine/database/model/Unique.html">Unique</a> unique = (Unique) unices.get(i);
<a name="250" href="#250">250</a>                 name = unique.getName();
<a name="251" href="#251">251</a>                 <strong>if</strong> (StringUtils.isEmpty(name))
<a name="252" href="#252">252</a>                 {
<a name="253" href="#253">253</a>                     name = acquireConstraintName(<span class="string">"U"</span>, i + 1);
<a name="254" href="#254">254</a>                     unique.setName(name);
<a name="255" href="#255">255</a>                 }
<a name="256" href="#256">256</a>             }
<a name="257" href="#257">257</a>         }
<a name="258" href="#258">258</a>         <strong>catch</strong> (EngineException nameAlreadyInUse)
<a name="259" href="#259">259</a>         {
<a name="260" href="#260">260</a>             log.error(nameAlreadyInUse, nameAlreadyInUse);
<a name="261" href="#261">261</a>         }
<a name="262" href="#262">262</a>     }
<a name="263" href="#263">263</a> 
<a name="264" href="#264">264</a>     <em>/**<em>*</em></em>
<a name="265" href="#265">265</a> <em>     * Macro to a constraint name.</em>
<a name="266" href="#266">266</a> <em>     *</em>
<a name="267" href="#267">267</a> <em>     * @param nameType constraint type</em>
<a name="268" href="#268">268</a> <em>     * @param nbr unique number for this constraint type</em>
<a name="269" href="#269">269</a> <em>     * @return unique name for constraint</em>
<a name="270" href="#270">270</a> <em>     * @throws EngineException</em>
<a name="271" href="#271">271</a> <em>     */</em>
<a name="272" href="#272">272</a>     <strong>private</strong> <strong>final</strong> String acquireConstra<strong>int</strong>Name(String nameType, <strong>int</strong> nbr)
<a name="273" href="#273">273</a>             throws <a href="../../../../../../org/apache/torque/engine/EngineException.html">EngineException</a>
<a name="274" href="#274">274</a>     {
<a name="275" href="#275">275</a>         List inputs = <strong>new</strong> ArrayList(4);
<a name="276" href="#276">276</a>         inputs.add(getDatabase());
<a name="277" href="#277">277</a>         inputs.add(getName());
<a name="278" href="#278">278</a>         inputs.add(nameType);
<a name="279" href="#279">279</a>         inputs.add(<strong>new</strong> Integer(nbr));
<a name="280" href="#280">280</a>         <strong>return</strong> NameFactory.generateName(NameFactory.CONSTRAINT_GENERATOR,
<a name="281" href="#281">281</a>                                         inputs);
<a name="282" href="#282">282</a>     }
<a name="283" href="#283">283</a> 
<a name="284" href="#284">284</a>     <em>/**<em>*</em></em>
<a name="285" href="#285">285</a> <em>     * Gets the value of base class for classes produced from this table.</em>
<a name="286" href="#286">286</a> <em>     *</em>
<a name="287" href="#287">287</a> <em>     * @return The base class for classes produced from this table.</em>
<a name="288" href="#288">288</a> <em>     */</em>
<a name="289" href="#289">289</a>     <strong>public</strong> String getBaseClass()
<a name="290" href="#290">290</a>     {
<a name="291" href="#291">291</a>         <strong>if</strong> (isAlias() &amp;&amp; baseClass == <strong>null</strong>)
<a name="292" href="#292">292</a>         {
<a name="293" href="#293">293</a>             <strong>return</strong> alias;
<a name="294" href="#294">294</a>         }
<a name="295" href="#295">295</a>         <strong>else</strong> <strong>if</strong> (baseClass == <strong>null</strong>)
<a name="296" href="#296">296</a>         {
<a name="297" href="#297">297</a>             <strong>return</strong> getDatabase().getBaseClass();
<a name="298" href="#298">298</a>         }
<a name="299" href="#299">299</a>         <strong>else</strong>
<a name="300" href="#300">300</a>         {
<a name="301" href="#301">301</a>             <strong>return</strong> baseClass;
<a name="302" href="#302">302</a>         }
<a name="303" href="#303">303</a>     }
<a name="304" href="#304">304</a> 
<a name="305" href="#305">305</a>     <em>/**<em>*</em></em>
<a name="306" href="#306">306</a> <em>     * Set the value of baseClass.</em>
<a name="307" href="#307">307</a> <em>     * @param v  Value to assign to baseClass.</em>
<a name="308" href="#308">308</a> <em>     */</em>
<a name="309" href="#309">309</a>     <strong>public</strong> <strong>void</strong> setBaseClass(String v)
<a name="310" href="#310">310</a>     {
<a name="311" href="#311">311</a>         <strong>this</strong>.baseClass = v;
<a name="312" href="#312">312</a>     }
<a name="313" href="#313">313</a> 
<a name="314" href="#314">314</a>     <em>/**<em>*</em></em>
<a name="315" href="#315">315</a> <em>     * Get the value of basePeer.</em>
<a name="316" href="#316">316</a> <em>     * @return value of basePeer.</em>
<a name="317" href="#317">317</a> <em>     */</em>
<a name="318" href="#318">318</a>     <strong>public</strong> String getBasePeer()
<a name="319" href="#319">319</a>     {
<a name="320" href="#320">320</a>         <strong>if</strong> (isAlias() &amp;&amp; basePeer == <strong>null</strong>)
<a name="321" href="#321">321</a>         {
<a name="322" href="#322">322</a>             <strong>return</strong> alias + <span class="string">"Peer"</span>;
<a name="323" href="#323">323</a>         }
<a name="324" href="#324">324</a>         <strong>else</strong> <strong>if</strong> (basePeer == <strong>null</strong>)
<a name="325" href="#325">325</a>         {
<a name="326" href="#326">326</a>             <strong>return</strong> getDatabase().getBasePeer();
<a name="327" href="#327">327</a>         }
<a name="328" href="#328">328</a>         <strong>else</strong>
<a name="329" href="#329">329</a>         {
<a name="330" href="#330">330</a>             <strong>return</strong> basePeer;
<a name="331" href="#331">331</a>         }
<a name="332" href="#332">332</a>     }
<a name="333" href="#333">333</a> 
<a name="334" href="#334">334</a>     <em>/**<em>*</em></em>
<a name="335" href="#335">335</a> <em>     * Set the value of basePeer.</em>
<a name="336" href="#336">336</a> <em>     * @param v  Value to assign to basePeer.</em>
<a name="337" href="#337">337</a> <em>     */</em>
<a name="338" href="#338">338</a>     <strong>public</strong> <strong>void</strong> setBasePeer(String v)
<a name="339" href="#339">339</a>     {
<a name="340" href="#340">340</a>         <strong>this</strong>.basePeer = v;
<a name="341" href="#341">341</a>     }
<a name="342" href="#342">342</a> 
<a name="343" href="#343">343</a>     <em>/**<em>*</em></em>
<a name="344" href="#344">344</a> <em>     * A utility function to create a new column from attrib and add it to this</em>
<a name="345" href="#345">345</a> <em>     * table.</em>
<a name="346" href="#346">346</a> <em>     *</em>
<a name="347" href="#347">347</a> <em>     * @param attrib xml attributes for the column to add</em>
<a name="348" href="#348">348</a> <em>     * @return the added column</em>
<a name="349" href="#349">349</a> <em>     */</em>
<a name="350" href="#350">350</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> addColumn(Attributes attrib)
<a name="351" href="#351">351</a>     {
<a name="352" href="#352">352</a>         <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> col = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a>();
<a name="353" href="#353">353</a>         col.setTable(<strong>this</strong>);
<a name="354" href="#354">354</a>         col.setCorrectGetters(false);
<a name="355" href="#355">355</a>         col.loadFromXML(attrib);
<a name="356" href="#356">356</a>         addColumn(col);
<a name="357" href="#357">357</a>         <strong>return</strong> col;
<a name="358" href="#358">358</a>     }
<a name="359" href="#359">359</a> 
<a name="360" href="#360">360</a>     <em>/**<em>*</em></em>
<a name="361" href="#361">361</a> <em>     * Adds a new column to the column list and set the</em>
<a name="362" href="#362">362</a> <em>     * parent table of the column to the current table</em>
<a name="363" href="#363">363</a> <em>     *</em>
<a name="364" href="#364">364</a> <em>     * @param col the column to add</em>
<a name="365" href="#365">365</a> <em>     */</em>
<a name="366" href="#366">366</a>     <strong>public</strong> <strong>void</strong> addColumn(<a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> col)
<a name="367" href="#367">367</a>     {
<a name="368" href="#368">368</a>         col.setTable (<strong>this</strong>);
<a name="369" href="#369">369</a>         <strong>if</strong> (col.isInheritance())
<a name="370" href="#370">370</a>         {
<a name="371" href="#371">371</a>             inheritanceColumn = col;
<a name="372" href="#372">372</a>         }
<a name="373" href="#373">373</a>         columnList.add(col);
<a name="374" href="#374">374</a>         columnsByName.put(col.getName(), col);
<a name="375" href="#375">375</a>         columnsByJavaName.put(col.getJavaName(), col);
<a name="376" href="#376">376</a>         col.setPosition(columnList.size());
<a name="377" href="#377">377</a>         needsTransactionInPostgres |= col.requiresTransactionInPostgres();
<a name="378" href="#378">378</a>     }
<a name="379" href="#379">379</a> 
<a name="380" href="#380">380</a>     <em>/**<em>*</em></em>
<a name="381" href="#381">381</a> <em>     * A utility function to create a new foreign key</em>
<a name="382" href="#382">382</a> <em>     * from attrib and add it to this table.</em>
<a name="383" href="#383">383</a> <em>     *</em>
<a name="384" href="#384">384</a> <em>     * @param attrib the xml attributes</em>
<a name="385" href="#385">385</a> <em>     * @return the created ForeignKey</em>
<a name="386" href="#386">386</a> <em>     */</em>
<a name="387" href="#387">387</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> addForeignKey(Attributes attrib)
<a name="388" href="#388">388</a>     {
<a name="389" href="#389">389</a>         <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> fk = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a>();
<a name="390" href="#390">390</a>         fk.loadFromXML(attrib);
<a name="391" href="#391">391</a>         addForeignKey(fk);
<a name="392" href="#392">392</a>         <strong>return</strong> fk;
<a name="393" href="#393">393</a>     }
<a name="394" href="#394">394</a> 
<a name="395" href="#395">395</a>     <em>/**<em>*</em></em>
<a name="396" href="#396">396</a> <em>     * Gets the column that subclasses of the class representing this</em>
<a name="397" href="#397">397</a> <em>     * table can be produced from.</em>
<a name="398" href="#398">398</a> <em>     */</em>
<a name="399" href="#399">399</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> getChildrenColumn()
<a name="400" href="#400">400</a>     {
<a name="401" href="#401">401</a>         <strong>return</strong> inheritanceColumn;
<a name="402" href="#402">402</a>     }
<a name="403" href="#403">403</a> 
<a name="404" href="#404">404</a>     <em>/**<em>*</em></em>
<a name="405" href="#405">405</a> <em>     * Get the objects that can be created from this table.</em>
<a name="406" href="#406">406</a> <em>     */</em>
<a name="407" href="#407">407</a>     <strong>public</strong> List getChildrenNames()
<a name="408" href="#408">408</a>     {
<a name="409" href="#409">409</a>         <strong>if</strong> (inheritanceColumn == <strong>null</strong>
<a name="410" href="#410">410</a>                 || !inheritanceColumn.isEnumeratedClasses())
<a name="411" href="#411">411</a>         {
<a name="412" href="#412">412</a>             <strong>return</strong> <strong>null</strong>;
<a name="413" href="#413">413</a>         }
<a name="414" href="#414">414</a>         List children = inheritanceColumn.getChildren();
<a name="415" href="#415">415</a>         List names = <strong>new</strong> ArrayList(children.size());
<a name="416" href="#416">416</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; children.size(); i++)
<a name="417" href="#417">417</a>         {
<a name="418" href="#418">418</a>             names.add(((Inheritance) children.get(i)).getClassName());
<a name="419" href="#419">419</a>         }
<a name="420" href="#420">420</a>         <strong>return</strong> names;
<a name="421" href="#421">421</a>     }
<a name="422" href="#422">422</a> 
<a name="423" href="#423">423</a>     <em>/**<em>*</em></em>
<a name="424" href="#424">424</a> <em>     * Adds the foreign key from another table that refers to this table.</em>
<a name="425" href="#425">425</a> <em>     *</em>
<a name="426" href="#426">426</a> <em>     * @param fk A foreign key refering to this table</em>
<a name="427" href="#427">427</a> <em>     */</em>
<a name="428" href="#428">428</a>     <strong>public</strong> <strong>void</strong> addReferrer(<a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> fk)
<a name="429" href="#429">429</a>     {
<a name="430" href="#430">430</a>         <strong>if</strong> (referrers == <strong>null</strong>)
<a name="431" href="#431">431</a>         {
<a name="432" href="#432">432</a>             referrers = <strong>new</strong> ArrayList(5);
<a name="433" href="#433">433</a>         }
<a name="434" href="#434">434</a>         referrers.add(fk);
<a name="435" href="#435">435</a>     }
<a name="436" href="#436">436</a> 
<a name="437" href="#437">437</a>     <em>/**<em>*</em></em>
<a name="438" href="#438">438</a> <em>     * Get list of references to this table.</em>
<a name="439" href="#439">439</a> <em>     *</em>
<a name="440" href="#440">440</a> <em>     * @return A list of references to this table</em>
<a name="441" href="#441">441</a> <em>     */</em>
<a name="442" href="#442">442</a>     <strong>public</strong> List getReferrers()
<a name="443" href="#443">443</a>     {
<a name="444" href="#444">444</a>         <strong>return</strong> referrers;
<a name="445" href="#445">445</a>     }
<a name="446" href="#446">446</a> 
<a name="447" href="#447">447</a>     <em>/**<em>*</em></em>
<a name="448" href="#448">448</a> <em>     * Set whether this table contains a foreign PK</em>
<a name="449" href="#449">449</a> <em>     *</em>
<a name="450" href="#450">450</a> <em>     * @param b</em>
<a name="451" href="#451">451</a> <em>     */</em>
<a name="452" href="#452">452</a>     <strong>public</strong> <strong>void</strong> setContainsForeignPK(<strong>boolean</strong> b)
<a name="453" href="#453">453</a>     {
<a name="454" href="#454">454</a>         containsForeignPK = b;
<a name="455" href="#455">455</a>     }
<a name="456" href="#456">456</a> 
<a name="457" href="#457">457</a>     <em>/**<em>*</em></em>
<a name="458" href="#458">458</a> <em>     * Determine if this table contains a foreign PK</em>
<a name="459" href="#459">459</a> <em>     */</em>
<a name="460" href="#460">460</a>     <strong>public</strong> <strong>boolean</strong> getContainsForeignPK()
<a name="461" href="#461">461</a>     {
<a name="462" href="#462">462</a>         <strong>return</strong> containsForeignPK;
<a name="463" href="#463">463</a>     }
<a name="464" href="#464">464</a> 
<a name="465" href="#465">465</a>     <em>/**<em>*</em></em>
<a name="466" href="#466">466</a> <em>     * A list of tables referenced by foreign keys in this table</em>
<a name="467" href="#467">467</a> <em>     *</em>
<a name="468" href="#468">468</a> <em>     * @return A list of tables</em>
<a name="469" href="#469">469</a> <em>     */</em>
<a name="470" href="#470">470</a>     <strong>public</strong> List getForeignTableNames()
<a name="471" href="#471">471</a>     {
<a name="472" href="#472">472</a>         <strong>if</strong> (foreignTableNames == <strong>null</strong>)
<a name="473" href="#473">473</a>         {
<a name="474" href="#474">474</a>             foreignTableNames = <strong>new</strong> ArrayList(1);
<a name="475" href="#475">475</a>         }
<a name="476" href="#476">476</a>         <strong>return</strong> foreignTableNames;
<a name="477" href="#477">477</a>     }
<a name="478" href="#478">478</a> 
<a name="479" href="#479">479</a>     <em>/**<em>*</em></em>
<a name="480" href="#480">480</a> <em>     * Adds a new FK to the FK list and set the</em>
<a name="481" href="#481">481</a> <em>     * parent table of the column to the current table</em>
<a name="482" href="#482">482</a> <em>     *</em>
<a name="483" href="#483">483</a> <em>     * @param fk A foreign key</em>
<a name="484" href="#484">484</a> <em>     */</em>
<a name="485" href="#485">485</a>     <strong>public</strong> <strong>void</strong> addForeignKey(<a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> fk)
<a name="486" href="#486">486</a>     {
<a name="487" href="#487">487</a>         fk.setTable (<strong>this</strong>);
<a name="488" href="#488">488</a>         foreignKeys.add(fk);
<a name="489" href="#489">489</a> 
<a name="490" href="#490">490</a>         <strong>if</strong> (foreignTableNames == <strong>null</strong>)
<a name="491" href="#491">491</a>         {
<a name="492" href="#492">492</a>             foreignTableNames = <strong>new</strong> ArrayList(5);
<a name="493" href="#493">493</a>         }
<a name="494" href="#494">494</a>         <strong>if</strong> (!foreignTableNames.contains(fk.getForeignTableName()))
<a name="495" href="#495">495</a>         {
<a name="496" href="#496">496</a>             foreignTableNames.add(fk.getForeignTableName());
<a name="497" href="#497">497</a>         }
<a name="498" href="#498">498</a>     }
<a name="499" href="#499">499</a> 
<a name="500" href="#500">500</a>     <em>/**<em>*</em></em>
<a name="501" href="#501">501</a> <em>     * Return true if the column requires a transaction in Postgres</em>
<a name="502" href="#502">502</a> <em>     */</em>
<a name="503" href="#503">503</a>     <strong>public</strong> <strong>boolean</strong> requiresTransactionInPostgres()
<a name="504" href="#504">504</a>     {
<a name="505" href="#505">505</a>         <strong>return</strong> needsTransactionInPostgres;
<a name="506" href="#506">506</a>     }
<a name="507" href="#507">507</a> 
<a name="508" href="#508">508</a>     <em>/**<em>*</em></em>
<a name="509" href="#509">509</a> <em>     * A utility function to create a new id method parameter</em>
<a name="510" href="#510">510</a> <em>     * from attrib and add it to this table.</em>
<a name="511" href="#511">511</a> <em>     */</em>
<a name="512" href="#512">512</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/IdMethodParameter.html">IdMethodParameter</a> addIdMethodParameter(Attributes attrib)
<a name="513" href="#513">513</a>     {
<a name="514" href="#514">514</a>         <a href="../../../../../../org/apache/torque/engine/database/model/IdMethodParameter.html">IdMethodParameter</a> imp = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/IdMethodParameter.html">IdMethodParameter</a>();
<a name="515" href="#515">515</a>         imp.loadFromXML(attrib);
<a name="516" href="#516">516</a>         addIdMethodParameter(imp);
<a name="517" href="#517">517</a>         <strong>return</strong> imp;
<a name="518" href="#518">518</a>     }
<a name="519" href="#519">519</a> 
<a name="520" href="#520">520</a> 
<a name="521" href="#521">521</a>     <em>/**<em>*</em></em>
<a name="522" href="#522">522</a> <em>     * Adds a new ID method parameter to the list and sets the parent</em>
<a name="523" href="#523">523</a> <em>     * table of the column associated with the supplied parameter to this table.</em>
<a name="524" href="#524">524</a> <em>     *</em>
<a name="525" href="#525">525</a> <em>     * @param imp The column to add as an ID method parameter.</em>
<a name="526" href="#526">526</a> <em>     */</em>
<a name="527" href="#527">527</a>     <strong>public</strong> <strong>void</strong> addIdMethodParameter(<a href="../../../../../../org/apache/torque/engine/database/model/IdMethodParameter.html">IdMethodParameter</a> imp)
<a name="528" href="#528">528</a>     {
<a name="529" href="#529">529</a>         imp.setTable(<strong>this</strong>);
<a name="530" href="#530">530</a>         <strong>if</strong> (idMethodParameters == <strong>null</strong>)
<a name="531" href="#531">531</a>         {
<a name="532" href="#532">532</a>             idMethodParameters = <strong>new</strong> ArrayList(2);
<a name="533" href="#533">533</a>         }
<a name="534" href="#534">534</a>         idMethodParameters.add(imp);
<a name="535" href="#535">535</a>     }
<a name="536" href="#536">536</a> 
<a name="537" href="#537">537</a>     <em>/**<em>*</em></em>
<a name="538" href="#538">538</a> <em>     * Adds a new index to the index list and set the</em>
<a name="539" href="#539">539</a> <em>     * parent table of the column to the current table</em>
<a name="540" href="#540">540</a> <em>     */</em>
<a name="541" href="#541">541</a>     <strong>public</strong> <strong>void</strong> addIndex(<a href="../../../../../../org/apache/torque/engine/database/model/Index.html">Index</a> index)
<a name="542" href="#542">542</a>     {
<a name="543" href="#543">543</a>         index.setTable (<strong>this</strong>);
<a name="544" href="#544">544</a>         indices.add(index);
<a name="545" href="#545">545</a>     }
<a name="546" href="#546">546</a> 
<a name="547" href="#547">547</a>     <em>/**<em>*</em></em>
<a name="548" href="#548">548</a> <em>     * A utility function to create a new index</em>
<a name="549" href="#549">549</a> <em>     * from attrib and add it to this table.</em>
<a name="550" href="#550">550</a> <em>     */</em>
<a name="551" href="#551">551</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Index.html">Index</a> addIndex(Attributes attrib)
<a name="552" href="#552">552</a>     {
<a name="553" href="#553">553</a>         <a href="../../../../../../org/apache/torque/engine/database/model/Index.html">Index</a> index = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Index.html">Index</a>();
<a name="554" href="#554">554</a>         index.loadFromXML(attrib);
<a name="555" href="#555">555</a>         addIndex(index);
<a name="556" href="#556">556</a>         <strong>return</strong> index;
<a name="557" href="#557">557</a>     }
<a name="558" href="#558">558</a> 
<a name="559" href="#559">559</a>     <em>/**<em>*</em></em>
<a name="560" href="#560">560</a> <em>     * Adds a new Unique to the Unique list and set the</em>
<a name="561" href="#561">561</a> <em>     * parent table of the column to the current table</em>
<a name="562" href="#562">562</a> <em>     */</em>
<a name="563" href="#563">563</a>     <strong>public</strong> <strong>void</strong> addUnique(<a href="../../../../../../org/apache/torque/engine/database/model/Unique.html">Unique</a> unique)
<a name="564" href="#564">564</a>     {
<a name="565" href="#565">565</a>         unique.setTable(<strong>this</strong>);
<a name="566" href="#566">566</a>         unices.add(unique);
<a name="567" href="#567">567</a>     }
<a name="568" href="#568">568</a> 
<a name="569" href="#569">569</a>     <em>/**<em>*</em></em>
<a name="570" href="#570">570</a> <em>     * A utility function to create a new Unique</em>
<a name="571" href="#571">571</a> <em>     * from attrib and add it to this table.</em>
<a name="572" href="#572">572</a> <em>     *</em>
<a name="573" href="#573">573</a> <em>     * @param attrib the xml attributes</em>
<a name="574" href="#574">574</a> <em>     */</em>
<a name="575" href="#575">575</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Unique.html">Unique</a> addUnique(Attributes attrib)
<a name="576" href="#576">576</a>     {
<a name="577" href="#577">577</a>         <a href="../../../../../../org/apache/torque/engine/database/model/Unique.html">Unique</a> unique = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Unique.html">Unique</a>();
<a name="578" href="#578">578</a>         unique.loadFromXML(attrib);
<a name="579" href="#579">579</a>         addUnique(unique);
<a name="580" href="#580">580</a>         <strong>return</strong> unique;
<a name="581" href="#581">581</a>     }
<a name="582" href="#582">582</a> 
<a name="583" href="#583">583</a>     <em>/**<em>*</em></em>
<a name="584" href="#584">584</a> <em>     * Get the name of the Table</em>
<a name="585" href="#585">585</a> <em>     */</em>
<a name="586" href="#586">586</a>     <strong>public</strong> String getName()
<a name="587" href="#587">587</a>     {
<a name="588" href="#588">588</a>         <strong>return</strong> name;
<a name="589" href="#589">589</a>     }
<a name="590" href="#590">590</a> 
<a name="591" href="#591">591</a>     <em>/**<em>*</em></em>
<a name="592" href="#592">592</a> <em>     * Set the name of the Table</em>
<a name="593" href="#593">593</a> <em>     */</em>
<a name="594" href="#594">594</a>     <strong>public</strong> <strong>void</strong> setName(String newName)
<a name="595" href="#595">595</a>     {
<a name="596" href="#596">596</a>         name = newName;
<a name="597" href="#597">597</a>     }
<a name="598" href="#598">598</a> 
<a name="599" href="#599">599</a>     <em>/**<em>*</em></em>
<a name="600" href="#600">600</a> <em>     * Get the description for the Table</em>
<a name="601" href="#601">601</a> <em>     */</em>
<a name="602" href="#602">602</a>     <strong>public</strong> String getDescription()
<a name="603" href="#603">603</a>     {
<a name="604" href="#604">604</a>         <strong>return</strong> description;
<a name="605" href="#605">605</a>     }
<a name="606" href="#606">606</a> 
<a name="607" href="#607">607</a>     <em>/**<em>*</em></em>
<a name="608" href="#608">608</a> <em>     * Set the description for the Table</em>
<a name="609" href="#609">609</a> <em>     *</em>
<a name="610" href="#610">610</a> <em>     * @param newDescription description for the Table</em>
<a name="611" href="#611">611</a> <em>     */</em>
<a name="612" href="#612">612</a>     <strong>public</strong> <strong>void</strong> setDescription(String newDescription)
<a name="613" href="#613">613</a>     {
<a name="614" href="#614">614</a>         description = newDescription;
<a name="615" href="#615">615</a>     }
<a name="616" href="#616">616</a> 
<a name="617" href="#617">617</a>     <em>/**<em>*</em></em>
<a name="618" href="#618">618</a> <em>     * Get name to use in Java sources</em>
<a name="619" href="#619">619</a> <em>     */</em>
<a name="620" href="#620">620</a>     <strong>public</strong> String getJavaName()
<a name="621" href="#621">621</a>     {
<a name="622" href="#622">622</a>         <strong>if</strong> (javaName == <strong>null</strong>)
<a name="623" href="#623">623</a>         {
<a name="624" href="#624">624</a>             List inputs = <strong>new</strong> ArrayList(2);
<a name="625" href="#625">625</a>             inputs.add(name);
<a name="626" href="#626">626</a>             inputs.add(javaNamingMethod);
<a name="627" href="#627">627</a>             <strong>try</strong>
<a name="628" href="#628">628</a>             {
<a name="629" href="#629">629</a>                 javaName = NameFactory.generateName(NameFactory.JAVA_GENERATOR,
<a name="630" href="#630">630</a>                                                     inputs);
<a name="631" href="#631">631</a>             }
<a name="632" href="#632">632</a>             <strong>catch</strong> (EngineException e)
<a name="633" href="#633">633</a>             {
<a name="634" href="#634">634</a>                 log.error(e, e);
<a name="635" href="#635">635</a>             }
<a name="636" href="#636">636</a>         }
<a name="637" href="#637">637</a>         <strong>return</strong> javaName;
<a name="638" href="#638">638</a>     }
<a name="639" href="#639">639</a> 
<a name="640" href="#640">640</a>     <em>/**<em>*</em></em>
<a name="641" href="#641">641</a> <em>     * Set name to use in Java sources</em>
<a name="642" href="#642">642</a> <em>     */</em>
<a name="643" href="#643">643</a>     <strong>public</strong> <strong>void</strong> setJavaName(String javaName)
<a name="644" href="#644">644</a>     {
<a name="645" href="#645">645</a>         <strong>this</strong>.javaName = javaName;
<a name="646" href="#646">646</a>     }
<a name="647" href="#647">647</a> 
<a name="648" href="#648">648</a>     <em>/**<em>*</em></em>
<a name="649" href="#649">649</a> <em>     * Get the method for generating pk's</em>
<a name="650" href="#650">650</a> <em>     */</em>
<a name="651" href="#651">651</a>     <strong>public</strong> String getIdMethod()
<a name="652" href="#652">652</a>     {
<a name="653" href="#653">653</a>         <strong>if</strong> (idMethod == <strong>null</strong>)
<a name="654" href="#654">654</a>         {
<a name="655" href="#655">655</a>             <strong>return</strong> IDMethod.NO_ID_METHOD;
<a name="656" href="#656">656</a>         }
<a name="657" href="#657">657</a>         <strong>else</strong>
<a name="658" href="#658">658</a>         {
<a name="659" href="#659">659</a>             <strong>return</strong> idMethod;
<a name="660" href="#660">660</a>         }
<a name="661" href="#661">661</a>     }
<a name="662" href="#662">662</a> 
<a name="663" href="#663">663</a>     <em>/**<em>*</em></em>
<a name="664" href="#664">664</a> <em>     * Set the method for generating pk's</em>
<a name="665" href="#665">665</a> <em>     */</em>
<a name="666" href="#666">666</a>     <strong>public</strong> <strong>void</strong> setIdMethod(String idMethod)
<a name="667" href="#667">667</a>     {
<a name="668" href="#668">668</a>         <strong>this</strong>.idMethod = idMethod;
<a name="669" href="#669">669</a>     }
<a name="670" href="#670">670</a> 
<a name="671" href="#671">671</a>     <em>/**<em>*</em></em>
<a name="672" href="#672">672</a> <em>     * Skip generating sql for this table (in the event it should</em>
<a name="673" href="#673">673</a> <em>     * not be created from scratch).</em>
<a name="674" href="#674">674</a> <em>     * @return value of skipSql.</em>
<a name="675" href="#675">675</a> <em>     */</em>
<a name="676" href="#676">676</a>     <strong>public</strong> <strong>boolean</strong> isSkipSql()
<a name="677" href="#677">677</a>     {
<a name="678" href="#678">678</a>         <strong>return</strong> (skipSql || isAlias() || isForReferenceOnly());
<a name="679" href="#679">679</a>     }
<a name="680" href="#680">680</a> 
<a name="681" href="#681">681</a>     <em>/**<em>*</em></em>
<a name="682" href="#682">682</a> <em>     * Set whether this table should have its creation sql generated.</em>
<a name="683" href="#683">683</a> <em>     * @param v  Value to assign to skipSql.</em>
<a name="684" href="#684">684</a> <em>     */</em>
<a name="685" href="#685">685</a>     <strong>public</strong> <strong>void</strong> setSkipSql(<strong>boolean</strong>  v)
<a name="686" href="#686">686</a>     {
<a name="687" href="#687">687</a>         <strong>this</strong>.skipSql = v;
<a name="688" href="#688">688</a>     }
<a name="689" href="#689">689</a> 
<a name="690" href="#690">690</a>     <em>/**<em>*</em></em>
<a name="691" href="#691">691</a> <em>     * JavaName of om object this entry references.</em>
<a name="692" href="#692">692</a> <em>     * @return value of external.</em>
<a name="693" href="#693">693</a> <em>     */</em>
<a name="694" href="#694">694</a>     <strong>public</strong> String getAlias()
<a name="695" href="#695">695</a>     {
<a name="696" href="#696">696</a>         <strong>return</strong> alias;
<a name="697" href="#697">697</a>     }
<a name="698" href="#698">698</a> 
<a name="699" href="#699">699</a>     <em>/**<em>*</em></em>
<a name="700" href="#700">700</a> <em>     * Is this table specified in the schema or is there just</em>
<a name="701" href="#701">701</a> <em>     * a foreign key reference to it.</em>
<a name="702" href="#702">702</a> <em>     * @return value of external.</em>
<a name="703" href="#703">703</a> <em>     */</em>
<a name="704" href="#704">704</a>     <strong>public</strong> <strong>boolean</strong> isAlias()
<a name="705" href="#705">705</a>     {
<a name="706" href="#706">706</a>         <strong>return</strong> (alias != <strong>null</strong>);
<a name="707" href="#707">707</a>     }
<a name="708" href="#708">708</a> 
<a name="709" href="#709">709</a>     <em>/**<em>*</em></em>
<a name="710" href="#710">710</a> <em>     * Set whether this table specified in the schema or is there just</em>
<a name="711" href="#711">711</a> <em>     * a foreign key reference to it.</em>
<a name="712" href="#712">712</a> <em>     * @param v  Value to assign to alias.</em>
<a name="713" href="#713">713</a> <em>     */</em>
<a name="714" href="#714">714</a>     <strong>public</strong> <strong>void</strong> setAlias(String v)
<a name="715" href="#715">715</a>     {
<a name="716" href="#716">716</a>         <strong>this</strong>.alias = v;
<a name="717" href="#717">717</a>     }
<a name="718" href="#718">718</a> 
<a name="719" href="#719">719</a> 
<a name="720" href="#720">720</a>     <em>/**<em>*</em></em>
<a name="721" href="#721">721</a> <em>     * Interface which objects for this table will implement</em>
<a name="722" href="#722">722</a> <em>     * @return value of interface.</em>
<a name="723" href="#723">723</a> <em>     */</em>
<a name="724" href="#724">724</a>     <strong>public</strong> String getInterface()
<a name="725" href="#725">725</a>     {
<a name="726" href="#726">726</a>         <strong>return</strong> enterface;
<a name="727" href="#727">727</a>     }
<a name="728" href="#728">728</a> 
<a name="729" href="#729">729</a>     <em>/**<em>*</em></em>
<a name="730" href="#730">730</a> <em>     * Interface which objects for this table will implement</em>
<a name="731" href="#731">731</a> <em>     * @param v  Value to assign to interface.</em>
<a name="732" href="#732">732</a> <em>     */</em>
<a name="733" href="#733">733</a>     <strong>public</strong> <strong>void</strong> setInterface(String  v)
<a name="734" href="#734">734</a>     {
<a name="735" href="#735">735</a>         <strong>this</strong>.enterface = v;
<a name="736" href="#736">736</a>     }
<a name="737" href="#737">737</a> 
<a name="738" href="#738">738</a>     <em>/**<em>*</em></em>
<a name="739" href="#739">739</a> <em>     * When a table is abstract, it marks the business object class that is</em>
<a name="740" href="#740">740</a> <em>     * generated as being abstract. If you have a table called "FOO", then the</em>
<a name="741" href="#741">741</a> <em>     * Foo BO will be &lt;code>public abstract class Foo&lt;/code></em>
<a name="742" href="#742">742</a> <em>     * This helps support class hierarchies</em>
<a name="743" href="#743">743</a> <em>     *</em>
<a name="744" href="#744">744</a> <em>     * @return value of abstractValue.</em>
<a name="745" href="#745">745</a> <em>     */</em>
<a name="746" href="#746">746</a>     <strong>public</strong> <strong>boolean</strong> isAbstract()
<a name="747" href="#747">747</a>     {
<a name="748" href="#748">748</a>         <strong>return</strong> abstractValue;
<a name="749" href="#749">749</a>     }
<a name="750" href="#750">750</a> 
<a name="751" href="#751">751</a>     <em>/**<em>*</em></em>
<a name="752" href="#752">752</a> <em>     * When a table is abstract, it marks the business object</em>
<a name="753" href="#753">753</a> <em>     * class that is generated as being abstract. If you have a</em>
<a name="754" href="#754">754</a> <em>     * table called "FOO", then the Foo BO will be</em>
<a name="755" href="#755">755</a> <em>     * &lt;code>public abstract class Foo&lt;/code></em>
<a name="756" href="#756">756</a> <em>     * This helps support class hierarchies</em>
<a name="757" href="#757">757</a> <em>     *</em>
<a name="758" href="#758">758</a> <em>     * @param v  Value to assign to abstractValue.</em>
<a name="759" href="#759">759</a> <em>     */</em>
<a name="760" href="#760">760</a>     <strong>public</strong> <strong>void</strong> setAbstract(<strong>boolean</strong>  v)
<a name="761" href="#761">761</a>     {
<a name="762" href="#762">762</a>         <strong>this</strong>.abstractValue = v;
<a name="763" href="#763">763</a>     }
<a name="764" href="#764">764</a> 
<a name="765" href="#765">765</a>     <em>/**<em>*</em></em>
<a name="766" href="#766">766</a> <em>     * Get the value of package.</em>
<a name="767" href="#767">767</a> <em>     *</em>
<a name="768" href="#768">768</a> <em>     * @return value of package.</em>
<a name="769" href="#769">769</a> <em>     */</em>
<a name="770" href="#770">770</a>     <strong>public</strong> String getPackage()
<a name="771" href="#771">771</a>     {
<a name="772" href="#772">772</a>         <strong>if</strong> (pkg != <strong>null</strong>)
<a name="773" href="#773">773</a>         {
<a name="774" href="#774">774</a>             <strong>return</strong> pkg;
<a name="775" href="#775">775</a>         }
<a name="776" href="#776">776</a>         <strong>else</strong>
<a name="777" href="#777">777</a>         {
<a name="778" href="#778">778</a>             <strong>return</strong> <strong>this</strong>.getDatabase().getPackage();
<a name="779" href="#779">779</a>         }
<a name="780" href="#780">780</a>     }
<a name="781" href="#781">781</a> 
<a name="782" href="#782">782</a>     <em>/**<em>*</em></em>
<a name="783" href="#783">783</a> <em>     * Set the value of package.</em>
<a name="784" href="#784">784</a> <em>     *</em>
<a name="785" href="#785">785</a> <em>     * @param v  Value to assign to package.</em>
<a name="786" href="#786">786</a> <em>     */</em>
<a name="787" href="#787">787</a>     <strong>public</strong> <strong>void</strong> setPackage(String v)
<a name="788" href="#788">788</a>     {
<a name="789" href="#789">789</a>         <strong>this</strong>.pkg = v;
<a name="790" href="#790">790</a>     }
<a name="791" href="#791">791</a> 
<a name="792" href="#792">792</a>     <em>/**<em>*</em></em>
<a name="793" href="#793">793</a> <em>     * Returns a List containing all the columns in the table</em>
<a name="794" href="#794">794</a> <em>     *</em>
<a name="795" href="#795">795</a> <em>     * @return a List containing all the columns</em>
<a name="796" href="#796">796</a> <em>     */</em>
<a name="797" href="#797">797</a>     <strong>public</strong> List getColumns()
<a name="798" href="#798">798</a>     {
<a name="799" href="#799">799</a>         <strong>return</strong> columnList;
<a name="800" href="#800">800</a>     }
<a name="801" href="#801">801</a> 
<a name="802" href="#802">802</a>     <em>/**<em>*</em></em>
<a name="803" href="#803">803</a> <em>     * Utility method to get the number of columns in this table</em>
<a name="804" href="#804">804</a> <em>     */</em>
<a name="805" href="#805">805</a>     <strong>public</strong> <strong>int</strong> getNumColumns()
<a name="806" href="#806">806</a>     {
<a name="807" href="#807">807</a>         <strong>return</strong> columnList.size();
<a name="808" href="#808">808</a>     }
<a name="809" href="#809">809</a> 
<a name="810" href="#810">810</a>     <em>/**<em>*</em></em>
<a name="811" href="#811">811</a> <em>     * Returns a List containing all the FKs in the table</em>
<a name="812" href="#812">812</a> <em>     *</em>
<a name="813" href="#813">813</a> <em>     * @return a List containing all the FKs</em>
<a name="814" href="#814">814</a> <em>     */</em>
<a name="815" href="#815">815</a>     <strong>public</strong> List getForeignKeys()
<a name="816" href="#816">816</a>     {
<a name="817" href="#817">817</a>         <strong>return</strong> foreignKeys;
<a name="818" href="#818">818</a>     }
<a name="819" href="#819">819</a> 
<a name="820" href="#820">820</a>     <em>/**<em>*</em></em>
<a name="821" href="#821">821</a> <em>     * Returns a Collection of parameters relevant for the chosen</em>
<a name="822" href="#822">822</a> <em>     * id generation method.</em>
<a name="823" href="#823">823</a> <em>     */</em>
<a name="824" href="#824">824</a>     <strong>public</strong> List getIdMethodParameters()
<a name="825" href="#825">825</a>     {
<a name="826" href="#826">826</a>         <strong>return</strong> idMethodParameters;
<a name="827" href="#827">827</a>     }
<a name="828" href="#828">828</a> 
<a name="829" href="#829">829</a>     <em>/**<em>*</em></em>
<a name="830" href="#830">830</a> <em>     * A name to use for creating a sequence if one is not specified.</em>
<a name="831" href="#831">831</a> <em>     *</em>
<a name="832" href="#832">832</a> <em>     * @return name of the sequence</em>
<a name="833" href="#833">833</a> <em>     */</em>
<a name="834" href="#834">834</a>     <strong>public</strong> String getSequenceName()
<a name="835" href="#835">835</a>     {
<a name="836" href="#836">836</a>         String result = <strong>null</strong>;
<a name="837" href="#837">837</a>         <strong>if</strong> (getIdMethod().equals(NATIVE))
<a name="838" href="#838">838</a>         {
<a name="839" href="#839">839</a>             List idMethodParams = getIdMethodParameters();
<a name="840" href="#840">840</a>             <strong>if</strong> (idMethodParams == <strong>null</strong>)
<a name="841" href="#841">841</a>             {
<a name="842" href="#842">842</a>                 result = getName() + <span class="string">"_SEQ"</span>;
<a name="843" href="#843">843</a>             }
<a name="844" href="#844">844</a>             <strong>else</strong>
<a name="845" href="#845">845</a>             {
<a name="846" href="#846">846</a>                 result = ((IdMethodParameter) idMethodParams.get(0)).getValue();
<a name="847" href="#847">847</a>             }
<a name="848" href="#848">848</a>         }
<a name="849" href="#849">849</a>         <strong>return</strong> result;
<a name="850" href="#850">850</a>     }
<a name="851" href="#851">851</a> 
<a name="852" href="#852">852</a>     <em>/**<em>*</em></em>
<a name="853" href="#853">853</a> <em>     * Returns a List containing all the indices in the table</em>
<a name="854" href="#854">854</a> <em>     *</em>
<a name="855" href="#855">855</a> <em>     * @return A List containing all the indices</em>
<a name="856" href="#856">856</a> <em>     */</em>
<a name="857" href="#857">857</a>     <strong>public</strong> List getIndices()
<a name="858" href="#858">858</a>     {
<a name="859" href="#859">859</a>         <strong>return</strong> indices;
<a name="860" href="#860">860</a>     }
<a name="861" href="#861">861</a> 
<a name="862" href="#862">862</a>     <em>/**<em>*</em></em>
<a name="863" href="#863">863</a> <em>     * Returns a List containing all the UKs in the table</em>
<a name="864" href="#864">864</a> <em>     *</em>
<a name="865" href="#865">865</a> <em>     * @return A List containing all the UKs</em>
<a name="866" href="#866">866</a> <em>     */</em>
<a name="867" href="#867">867</a>     <strong>public</strong> List getUnices()
<a name="868" href="#868">868</a>     {
<a name="869" href="#869">869</a>         <strong>return</strong> unices;
<a name="870" href="#870">870</a>     }
<a name="871" href="#871">871</a> 
<a name="872" href="#872">872</a>     <em>/**<em>*</em></em>
<a name="873" href="#873">873</a> <em>     * Returns a specified column.</em>
<a name="874" href="#874">874</a> <em>     *</em>
<a name="875" href="#875">875</a> <em>     * @param name name of the column</em>
<a name="876" href="#876">876</a> <em>     * @return Return a Column object or null if it does not exist.</em>
<a name="877" href="#877">877</a> <em>     */</em>
<a name="878" href="#878">878</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> getColumn(String name)
<a name="879" href="#879">879</a>     {
<a name="880" href="#880">880</a>         <strong>return</strong> (Column) columnsByName.get(name);
<a name="881" href="#881">881</a>     }
<a name="882" href="#882">882</a> 
<a name="883" href="#883">883</a>     <em>/**<em>*</em></em>
<a name="884" href="#884">884</a> <em>     * Returns a specified column.</em>
<a name="885" href="#885">885</a> <em>     *</em>
<a name="886" href="#886">886</a> <em>     * @param javaName java name of the column</em>
<a name="887" href="#887">887</a> <em>     * @return Return a Column object or null if it does not exist.</em>
<a name="888" href="#888">888</a> <em>     */</em>
<a name="889" href="#889">889</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> getColumnByJavaName(String javaName)
<a name="890" href="#890">890</a>     {
<a name="891" href="#891">891</a>         <strong>return</strong> (Column) columnsByJavaName.get(javaName);
<a name="892" href="#892">892</a>     }
<a name="893" href="#893">893</a> 
<a name="894" href="#894">894</a>     <em>/**<em>*</em></em>
<a name="895" href="#895">895</a> <em>     * Return the first foreign key that includes col in it's list</em>
<a name="896" href="#896">896</a> <em>     * of local columns.  Eg. Foreign key (a,b,c) refrences tbl(x,y,z)</em>
<a name="897" href="#897">897</a> <em>     * will be returned of col is either a,b or c.</em>
<a name="898" href="#898">898</a> <em>     *</em>
<a name="899" href="#899">899</a> <em>     * @param col column name included in the key</em>
<a name="900" href="#900">900</a> <em>     * @return Return a Column object or null if it does not exist.</em>
<a name="901" href="#901">901</a> <em>     */</em>
<a name="902" href="#902">902</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> getForeignKey(String col)
<a name="903" href="#903">903</a>     {
<a name="904" href="#904">904</a>         <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> firstFK = <strong>null</strong>;
<a name="905" href="#905">905</a>         <strong>for</strong> (Iterator iter = <strong>for</strong>eignKeys.iterator(); iter.hasNext();)
<a name="906" href="#906">906</a>         {
<a name="907" href="#907">907</a>             <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> key = (ForeignKey) iter.next();
<a name="908" href="#908">908</a>             <strong>if</strong> (key.getLocalColumns().contains(col))
<a name="909" href="#909">909</a>             {
<a name="910" href="#910">910</a>                 <strong>if</strong> (firstFK == <strong>null</strong>)
<a name="911" href="#911">911</a>                 {
<a name="912" href="#912">912</a>                     firstFK = key;
<a name="913" href="#913">913</a>                 }
<a name="914" href="#914">914</a>                 <strong>else</strong>
<a name="915" href="#915">915</a>                 {
<a name="916" href="#916">916</a>                     <em class="comment">//System.out.println(col+" is in multiple FKs.  This is not"</em>
<a name="917" href="#917">917</a>                     <em class="comment">//                   + " being handled properly.");</em>
<a name="918" href="#918">918</a>                     <em class="comment">//throw new IllegalStateException("Cannot call method if " +</em>
<a name="919" href="#919">919</a>                     <em class="comment">//    "column is referenced multiple times");</em>
<a name="920" href="#920">920</a>                 }
<a name="921" href="#921">921</a>             }
<a name="922" href="#922">922</a>         }
<a name="923" href="#923">923</a>         <strong>return</strong> firstFK;
<a name="924" href="#924">924</a>     }
<a name="925" href="#925">925</a> 
<a name="926" href="#926">926</a>     <em>/**<em>*</em></em>
<a name="927" href="#927">927</a> <em>     * Returns true if the table contains a specified column</em>
<a name="928" href="#928">928</a> <em>     *</em>
<a name="929" href="#929">929</a> <em>     * @param col the column</em>
<a name="930" href="#930">930</a> <em>     * @return true if the table contains the column</em>
<a name="931" href="#931">931</a> <em>     */</em>
<a name="932" href="#932">932</a>     <strong>public</strong> <strong>boolean</strong> containsColumn(<a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> col)
<a name="933" href="#933">933</a>     {
<a name="934" href="#934">934</a>         <strong>return</strong> columnList.contains(col);
<a name="935" href="#935">935</a>     }
<a name="936" href="#936">936</a> 
<a name="937" href="#937">937</a>     <em>/**<em>*</em></em>
<a name="938" href="#938">938</a> <em>     * Returns true if the table contains a specified column</em>
<a name="939" href="#939">939</a> <em>     *</em>
<a name="940" href="#940">940</a> <em>     * @param name name of the column</em>
<a name="941" href="#941">941</a> <em>     * @return true if the table contains the column</em>
<a name="942" href="#942">942</a> <em>     */</em>
<a name="943" href="#943">943</a>     <strong>public</strong> <strong>boolean</strong> containsColumn(String name)
<a name="944" href="#944">944</a>     {
<a name="945" href="#945">945</a>         <strong>return</strong> (getColumn(name) != <strong>null</strong>);
<a name="946" href="#946">946</a>     }
<a name="947" href="#947">947</a> 
<a name="948" href="#948">948</a>     <em>/**<em>*</em></em>
<a name="949" href="#949">949</a> <em>     * Set the parent of the table</em>
<a name="950" href="#950">950</a> <em>     *</em>
<a name="951" href="#951">951</a> <em>     * @param parent the parant database</em>
<a name="952" href="#952">952</a> <em>     */</em>
<a name="953" href="#953">953</a>     <strong>public</strong> <strong>void</strong> setDatabase(<a href="../../../../../../org/apache/torque/engine/database/model/Database.html">Database</a> parent)
<a name="954" href="#954">954</a>     {
<a name="955" href="#955">955</a>         tableParent = parent;
<a name="956" href="#956">956</a>     }
<a name="957" href="#957">957</a> 
<a name="958" href="#958">958</a>     <em>/**<em>*</em></em>
<a name="959" href="#959">959</a> <em>     * Get the parent of the table</em>
<a name="960" href="#960">960</a> <em>     *</em>
<a name="961" href="#961">961</a> <em>     * @return the parant database</em>
<a name="962" href="#962">962</a> <em>     */</em>
<a name="963" href="#963">963</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Database.html">Database</a> getDatabase()
<a name="964" href="#964">964</a>     {
<a name="965" href="#965">965</a>         <strong>return</strong> tableParent;
<a name="966" href="#966">966</a>     }
<a name="967" href="#967">967</a> 
<a name="968" href="#968">968</a>     <em>/**<em>*</em></em>
<a name="969" href="#969">969</a> <em>     * Flag to determine if code/sql gets created for this table.</em>
<a name="970" href="#970">970</a> <em>     * Table will be skipped, if return true.</em>
<a name="971" href="#971">971</a> <em>     * @return value of forReferenceOnly.</em>
<a name="972" href="#972">972</a> <em>     */</em>
<a name="973" href="#973">973</a>     <strong>public</strong> <strong>boolean</strong> isForReferenceOnly()
<a name="974" href="#974">974</a>     {
<a name="975" href="#975">975</a>         <strong>return</strong> forReferenceOnly;
<a name="976" href="#976">976</a>     }
<a name="977" href="#977">977</a> 
<a name="978" href="#978">978</a>     <em>/**<em>*</em></em>
<a name="979" href="#979">979</a> <em>     * Flag to determine if code/sql gets created for this table.</em>
<a name="980" href="#980">980</a> <em>     * Table will be skipped, if set to true.</em>
<a name="981" href="#981">981</a> <em>     * @param v  Value to assign to forReferenceOnly.</em>
<a name="982" href="#982">982</a> <em>     */</em>
<a name="983" href="#983">983</a>     <strong>public</strong> <strong>void</strong> setForReferenceOnly(<strong>boolean</strong>  v)
<a name="984" href="#984">984</a>     {
<a name="985" href="#985">985</a>         <strong>this</strong>.forReferenceOnly = v;
<a name="986" href="#986">986</a>     }
<a name="987" href="#987">987</a> 
<a name="988" href="#988">988</a>     <em>/**<em>*</em></em>
<a name="989" href="#989">989</a> <em>     * Returns a XML representation of this table.</em>
<a name="990" href="#990">990</a> <em>     *</em>
<a name="991" href="#991">991</a> <em>     * @return XML representation of this table</em>
<a name="992" href="#992">992</a> <em>     */</em>
<a name="993" href="#993">993</a>     <strong>public</strong> String toString()
<a name="994" href="#994">994</a>     {
<a name="995" href="#995">995</a>         StringBuffer result = <strong>new</strong> StringBuffer();
<a name="996" href="#996">996</a> 
<a name="997" href="#997">997</a>         result.append (<span class="string">"&lt;table name=\&quot;"</span>)
<a name="998" href="#998">998</a>               .append(name)
<a name="999" href="#999">999</a>               .append('\&quot;');
<a name="1000" href="#1000">1000</a> 
<a name="1001" href="#1001">1001</a>         <strong>if</strong> (javaName != <strong>null</strong>)
<a name="1002" href="#1002">1002</a>         {
<a name="1003" href="#1003">1003</a>             result.append(<span class="string">" javaName=\&quot;"</span>)
<a name="1004" href="#1004">1004</a>                   .append(javaName)
<a name="1005" href="#1005">1005</a>                   .append('\&quot;');
<a name="1006" href="#1006">1006</a>         }
<a name="1007" href="#1007">1007</a> 
<a name="1008" href="#1008">1008</a>         <strong>if</strong> (idMethod != <strong>null</strong>)
<a name="1009" href="#1009">1009</a>         {
<a name="1010" href="#1010">1010</a>             result.append(<span class="string">" idMethod=\&quot;"</span>)
<a name="1011" href="#1011">1011</a>                   .append(idMethod)
<a name="1012" href="#1012">1012</a>                   .append('\&quot;');
<a name="1013" href="#1013">1013</a>         }
<a name="1014" href="#1014">1014</a> 
<a name="1015" href="#1015">1015</a>         <strong>if</strong> (skipSql)
<a name="1016" href="#1016">1016</a>         {
<a name="1017" href="#1017">1017</a>             result.append(<span class="string">" skipSql=\&quot;"</span>)
<a name="1018" href="#1018">1018</a>                   .append(<strong>new</strong> Boolean(skipSql))
<a name="1019" href="#1019">1019</a>                   .append('\&quot;');
<a name="1020" href="#1020">1020</a>         }
<a name="1021" href="#1021">1021</a> 
<a name="1022" href="#1022">1022</a>         <strong>if</strong> (abstractValue)
<a name="1023" href="#1023">1023</a>         {
<a name="1024" href="#1024">1024</a>             result.append(<span class="string">" abstract=\&quot;"</span>)
<a name="1025" href="#1025">1025</a>                   .append(<strong>new</strong> Boolean(abstractValue))
<a name="1026" href="#1026">1026</a>                   .append('\&quot;');
<a name="1027" href="#1027">1027</a>         }
<a name="1028" href="#1028">1028</a> 
<a name="1029" href="#1029">1029</a>         <strong>if</strong> (baseClass != <strong>null</strong>)
<a name="1030" href="#1030">1030</a>         {
<a name="1031" href="#1031">1031</a>             result.append(<span class="string">" baseClass=\&quot;"</span>)
<a name="1032" href="#1032">1032</a>                   .append(baseClass)
<a name="1033" href="#1033">1033</a>                   .append('\&quot;');
<a name="1034" href="#1034">1034</a>         }
<a name="1035" href="#1035">1035</a> 
<a name="1036" href="#1036">1036</a>         <strong>if</strong> (basePeer != <strong>null</strong>)
<a name="1037" href="#1037">1037</a>         {
<a name="1038" href="#1038">1038</a>             result.append(<span class="string">" basePeer=\&quot;"</span>)
<a name="1039" href="#1039">1039</a>                   .append(basePeer)
<a name="1040" href="#1040">1040</a>                   .append('\&quot;');
<a name="1041" href="#1041">1041</a>         }
<a name="1042" href="#1042">1042</a> 
<a name="1043" href="#1043">1043</a>         result.append(<span class="string">">\n"</span>);
<a name="1044" href="#1044">1044</a> 
<a name="1045" href="#1045">1045</a>         <strong>if</strong> (columnList != <strong>null</strong>)
<a name="1046" href="#1046">1046</a>         {
<a name="1047" href="#1047">1047</a>             <strong>for</strong> (Iterator iter = columnList.iterator(); iter.hasNext();)
<a name="1048" href="#1048">1048</a>             {
<a name="1049" href="#1049">1049</a>                 result.append(iter.next());
<a name="1050" href="#1050">1050</a>             }
<a name="1051" href="#1051">1051</a>         }
<a name="1052" href="#1052">1052</a> 
<a name="1053" href="#1053">1053</a>         <strong>if</strong> (foreignKeys != <strong>null</strong>)
<a name="1054" href="#1054">1054</a>         {
<a name="1055" href="#1055">1055</a>             <strong>for</strong> (Iterator iter = <strong>for</strong>eignKeys.iterator(); iter.hasNext();)
<a name="1056" href="#1056">1056</a>             {
<a name="1057" href="#1057">1057</a>                 result.append(iter.next());
<a name="1058" href="#1058">1058</a>             }
<a name="1059" href="#1059">1059</a>         }
<a name="1060" href="#1060">1060</a> 
<a name="1061" href="#1061">1061</a>         <strong>if</strong> (idMethodParameters != <strong>null</strong>)
<a name="1062" href="#1062">1062</a>         {
<a name="1063" href="#1063">1063</a>             Iterator iter = idMethodParameters.iterator();
<a name="1064" href="#1064">1064</a>             <strong>while</strong> (iter.hasNext())
<a name="1065" href="#1065">1065</a>             {
<a name="1066" href="#1066">1066</a>                 result.append(iter.next());
<a name="1067" href="#1067">1067</a>             }
<a name="1068" href="#1068">1068</a>         }
<a name="1069" href="#1069">1069</a> 
<a name="1070" href="#1070">1070</a>         result.append (<span class="string">"&lt;/table>\n"</span>);
<a name="1071" href="#1071">1071</a> 
<a name="1072" href="#1072">1072</a>         <strong>return</strong> result.toString();
<a name="1073" href="#1073">1073</a>     }
<a name="1074" href="#1074">1074</a> 
<a name="1075" href="#1075">1075</a>     <em>/**<em>*</em></em>
<a name="1076" href="#1076">1076</a> <em>     * Returns the collection of Columns which make up the single primary</em>
<a name="1077" href="#1077">1077</a> <em>     * key for this table.</em>
<a name="1078" href="#1078">1078</a> <em>     *</em>
<a name="1079" href="#1079">1079</a> <em>     * @return A list of the primary key parts.</em>
<a name="1080" href="#1080">1080</a> <em>     */</em>
<a name="1081" href="#1081">1081</a>     <strong>public</strong> List getPrimaryKey()
<a name="1082" href="#1082">1082</a>     {
<a name="1083" href="#1083">1083</a>         List pk = <strong>new</strong> ArrayList(columnList.size());
<a name="1084" href="#1084">1084</a> 
<a name="1085" href="#1085">1085</a>         Iterator iter = columnList.iterator();
<a name="1086" href="#1086">1086</a>         <strong>while</strong> (iter.hasNext())
<a name="1087" href="#1087">1087</a>         {
<a name="1088" href="#1088">1088</a>             <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> col = (Column) iter.next();
<a name="1089" href="#1089">1089</a>             <strong>if</strong> (col.isPrimaryKey())
<a name="1090" href="#1090">1090</a>             {
<a name="1091" href="#1091">1091</a>                 pk.add(col);
<a name="1092" href="#1092">1092</a>             }
<a name="1093" href="#1093">1093</a>         }
<a name="1094" href="#1094">1094</a>         <strong>return</strong> pk;
<a name="1095" href="#1095">1095</a>     }
<a name="1096" href="#1096">1096</a> 
<a name="1097" href="#1097">1097</a>     <em>/**<em>*</em></em>
<a name="1098" href="#1098">1098</a> <em>     * Determine whether this table has a primary key.</em>
<a name="1099" href="#1099">1099</a> <em>     *</em>
<a name="1100" href="#1100">1100</a> <em>     * @return Whether this table has any primary key parts.</em>
<a name="1101" href="#1101">1101</a> <em>     */</em>
<a name="1102" href="#1102">1102</a>     <strong>public</strong> <strong>boolean</strong> hasPrimaryKey()
<a name="1103" href="#1103">1103</a>     {
<a name="1104" href="#1104">1104</a>         <strong>return</strong> (getPrimaryKey().size() > 0);
<a name="1105" href="#1105">1105</a>     }
<a name="1106" href="#1106">1106</a> 
<a name="1107" href="#1107">1107</a>     <em>/**<em>*</em></em>
<a name="1108" href="#1108">1108</a> <em>     * Returns all parts of the primary key, separated by commas.</em>
<a name="1109" href="#1109">1109</a> <em>     *</em>
<a name="1110" href="#1110">1110</a> <em>     * @return A CSV list of primary key parts.</em>
<a name="1111" href="#1111">1111</a> <em>     */</em>
<a name="1112" href="#1112">1112</a>     <strong>public</strong> String printPrimaryKey()
<a name="1113" href="#1113">1113</a>     {
<a name="1114" href="#1114">1114</a>         <strong>return</strong> printList(columnList);
<a name="1115" href="#1115">1115</a>     }
<a name="1116" href="#1116">1116</a> 
<a name="1117" href="#1117">1117</a>     <em>/**<em>*</em></em>
<a name="1118" href="#1118">1118</a> <em>     * Returns the elements of the list, separated by commas.</em>
<a name="1119" href="#1119">1119</a> <em>     *</em>
<a name="1120" href="#1120">1120</a> <em>     * @param list a list of Columns</em>
<a name="1121" href="#1121">1121</a> <em>     * @return A CSV list.</em>
<a name="1122" href="#1122">1122</a> <em>     */</em>
<a name="1123" href="#1123">1123</a>     <strong>private</strong> String printList(List list)
<a name="1124" href="#1124">1124</a>     {
<a name="1125" href="#1125">1125</a>         StringBuffer result = <strong>new</strong> StringBuffer();
<a name="1126" href="#1126">1126</a>         <strong>boolean</strong> comma = false;
<a name="1127" href="#1127">1127</a>         <strong>for</strong> (Iterator iter = list.iterator(); iter.hasNext();)
<a name="1128" href="#1128">1128</a>         {
<a name="1129" href="#1129">1129</a>             <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> col = (Column) iter.next();
<a name="1130" href="#1130">1130</a>             <strong>if</strong> (col.isPrimaryKey())
<a name="1131" href="#1131">1131</a>             {
<a name="1132" href="#1132">1132</a>                 <strong>if</strong> (comma)
<a name="1133" href="#1133">1133</a>                 {
<a name="1134" href="#1134">1134</a>                     result.append(',');
<a name="1135" href="#1135">1135</a>                 }
<a name="1136" href="#1136">1136</a>                 <strong>else</strong>
<a name="1137" href="#1137">1137</a>                 {
<a name="1138" href="#1138">1138</a>                     comma = <strong>true</strong>;
<a name="1139" href="#1139">1139</a>                 }
<a name="1140" href="#1140">1140</a>                 result.append(col.getName());
<a name="1141" href="#1141">1141</a>             }
<a name="1142" href="#1142">1142</a>         }
<a name="1143" href="#1143">1143</a>         <strong>return</strong> result.toString();
<a name="1144" href="#1144">1144</a>     }
<a name="1145" href="#1145">1145</a> 
<a name="1146" href="#1146">1146</a>     <em>/**<em>*</em></em>
<a name="1147" href="#1147">1147</a> <em>     * Force all columns to set the correctGetters property.</em>
<a name="1148" href="#1148">1148</a> <em>     *</em>
<a name="1149" href="#1149">1149</a> <em>     * @param value The new value of the correctGetters property.</em>
<a name="1150" href="#1150">1150</a> <em>     * @since 3.2</em>
<a name="1151" href="#1151">1151</a> <em>     */</em>
<a name="1152" href="#1152">1152</a>     <strong>public</strong> <strong>void</strong> setCorrectGetters(Boolean value)
<a name="1153" href="#1153">1153</a>     {
<a name="1154" href="#1154">1154</a>         <strong>boolean</strong> correctGetters = value != <strong>null</strong> &amp;&amp; value.<strong>boolean</strong>Value();
<a name="1155" href="#1155">1155</a>         <strong>for</strong> (Iterator it = columnList.iterator(); it.hasNext();)
<a name="1156" href="#1156">1156</a>         {
<a name="1157" href="#1157">1157</a>             <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> col = (Column) it.next();
<a name="1158" href="#1158">1158</a>             col.setCorrectGetters(correctGetters);
<a name="1159" href="#1159">1159</a>         }
<a name="1160" href="#1160">1160</a>     }
<a name="1161" href="#1161">1161</a> 
<a name="1162" href="#1162">1162</a>     <em>/**<em>*</em></em>
<a name="1163" href="#1163">1163</a> <em>     * Add an XML Specified option key/value pair to this element's option set.</em>
<a name="1164" href="#1164">1164</a> <em>     *</em>
<a name="1165" href="#1165">1165</a> <em>     * @param key the key of the option.</em>
<a name="1166" href="#1166">1166</a> <em>     * @param value the value of the option.</em>
<a name="1167" href="#1167">1167</a> <em>     */</em>
<a name="1168" href="#1168">1168</a>     <strong>public</strong> <strong>void</strong> addOption(String key, String value)
<a name="1169" href="#1169">1169</a>     {
<a name="1170" href="#1170">1170</a>         options.put(key, value);
<a name="1171" href="#1171">1171</a>     }
<a name="1172" href="#1172">1172</a> 
<a name="1173" href="#1173">1173</a>     <em>/**<em>*</em></em>
<a name="1174" href="#1174">1174</a> <em>     * Get the value that was associated with this key in an XML option</em>
<a name="1175" href="#1175">1175</a> <em>     * element.</em>
<a name="1176" href="#1176">1176</a> <em>     *</em>
<a name="1177" href="#1177">1177</a> <em>     * @param key the key of the option.</em>
<a name="1178" href="#1178">1178</a> <em>     * @return The value for the key or a null.</em>
<a name="1179" href="#1179">1179</a> <em>     */</em>
<a name="1180" href="#1180">1180</a>     <strong>public</strong> String getOption(String key)
<a name="1181" href="#1181">1181</a>     {
<a name="1182" href="#1182">1182</a>         <strong>return</strong> (String) options.get(key);
<a name="1183" href="#1183">1183</a>     }
<a name="1184" href="#1184">1184</a> 
<a name="1185" href="#1185">1185</a>     <em>/**<em>*</em></em>
<a name="1186" href="#1186">1186</a> <em>     * Gets the full ordered hashtable array of items specified by XML option</em>
<a name="1187" href="#1187">1187</a> <em>     * statements under this element.&lt;p></em>
<a name="1188" href="#1188">1188</a> <em>     *</em>
<a name="1189" href="#1189">1189</a> <em>     * Note, this is not thread save but since it's only used for</em>
<a name="1190" href="#1190">1190</a> <em>     * generation which is single threaded, there should be minimum</em>
<a name="1191" href="#1191">1191</a> <em>     * danger using this in Velocity.</em>
<a name="1192" href="#1192">1192</a> <em>     *</em>
<a name="1193" href="#1193">1193</a> <em>     * @return An Map of all options. Will not be null but may be empty.</em>
<a name="1194" href="#1194">1194</a> <em>     */</em>
<a name="1195" href="#1195">1195</a>     <strong>public</strong> Map getOptions()
<a name="1196" href="#1196">1196</a>     {
<a name="1197" href="#1197">1197</a>         <strong>return</strong> options;
<a name="1198" href="#1198">1198</a>     }
<a name="1199" href="#1199">1199</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

